docs(document-translation): document Cat 1 file formats (IDML, XML, JSON, DITA, MIF)#387
Merged
Merged
Conversation
…SON, DITA, MIF) Add Cat 1 formats to all supported-format listings, update XLIFF version wording to include 1.2/2.0/2.1, bump Word/PowerPoint/PDF API Pro size cap to 100 MB, and add a Format-specific gotchas section to the document-translation best-practices page. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
shirgoldbird
reviewed
Jul 7, 2026
shirgoldbird
reviewed
Jul 7, 2026
shirgoldbird
requested changes
Jul 7, 2026
shirgoldbird
left a comment
shirgoldbird
left a comment
Member
There was a problem hiding this comment.
Nice, I learned a few things about our doctrans api :) 2 small nits
Co-authored-by: Shir Goldberg <3937986+shirgoldbird@users.noreply.github.com>
Use uppercase format acronyms without leading dot in narrative text, matching the existing convention in deepl-cli.mdx and deepl-mcp-server.mdx. Extensions in code spans (backticks, curl examples) stay lowercase with dot. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
api-reference/document.mdx,docs/getting-started/about.mdx, Java cookbook).docs/resources/usage-limits.mdx: new rows for IDML (30 MB Pro), MIF (30 MB Pro), XML (10 MB), JSON (1 MB), DITA (5 MB); bump Word / PowerPoint / PDF from 30 MB → 100 MB on API Pro; rewrite XLIFF footnote.docs/best-practices/document-translations.mdx:<file>lang ignored), DITA (.ditaonly; codeblock newline collapse), JSON (1 MB limit; embedded HTML/Markdown), IDML (font substitution; overset), and MIF (must be FrameMaker; UTF-8; MIF ≥ 8.00).Test plan
docs/best-practices/document-translations.mdxcleanly (headings, bullet spacing, code spans).docs/resources/usage-limits.mdxtable renders with correct new rows and 100 MB values for Word / PowerPoint / PDF (API Pro)./api-reference/documentshows the expanded format list in both the top listing and thefileparameter description./api-reference/document/upload-and-translate-a-documentpicks up the OpenAPI updates.docs/getting-started/about.mdxone-liner still reads cleanly.